api_result Element

Description

starts a results connection.

Namespace

(none)

Diagram

Overview

api_result

starts a results connection.

Sequence

authentication xs:string

Confirmation that the username and password has been accepted.

num_results xs:int

Defines the number of results in this report.

result 0..∞

You can have multiple results per optout report.

Sequence

type xs:string

Defines the type of report. In this case it will always be "optout".

campaign_id xs:string

This is the PRODOCOM system ID for a campaign.

msg_id xs:string

This is the PRODOCOM system ID for a message within a campaign. A campaign may contain many messages each with many destinations.

categoryname xs:string

The optout category used when building an email campaign.

optout xs:string

There are two options here - "sub" or "all. If "sub" is indicated it means that the recipient only opted out of campaigns using the same category as this job. If "all" then the recipient has opted out of all further communication via this medium.

date_gmt xs:string

The GMT (Greenwich Mean time) date of the optout from the recipient.

recipient xs:string

The intended recipients delivery address. This could be a fax number, email address, phone number or Mobile App Id .

Source

<xs:element name="api_result" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType>
    <xs:sequence>
      <xs:element type="xs:string" name="authentication" />
      <xs:element type="xs:int" name="num_results" />
      <xs:element name="result" maxOccurs="unbounded" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element type="xs:string" name="type" />
            <xs:element type="xs:string" name="campaign_id" />
            <xs:element type="xs:string" name="msg_id" />
            <xs:element type="xs:string" name="categoryname" />
            <xs:element type="xs:string" name="optout" />
            <xs:element type="xs:string" name="date_gmt" />
            <xs:element type="xs:string" name="recipient" />
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:element>